<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BrokenIRC: BrokenIRC rev 0.43 RFC Write Up</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">BrokenIRC
   &#160;<span id="projectnumber">0.0.42</span>
   </div>
   <div id="projectbrief">A &#39;not so functionnal&#39; irc server and a WIP client</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">BrokenIRC rev 0.43 RFC Write Up </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2>Current version <a href="https://github.com/trevisg/PSU_myirc_2017BrokenStuffisBack/releases/tag/vQuickAndDirty">#QuickAndDirty</a></h2>
<p>This is (supposed to be) an EPITECH BrokenIRC Protocol RFC's <a href="https://tools.ietf.org/html/rfc2812">2812</a> &amp; oldest <a href="https://tools.ietf.org/html/rfc1459">1459</a> compliant IRCd C server</p>
<h5>From Subject :</h5>
<blockquote class="doxtable">
<p>You <b>MUST</b> not use thread(), fork() &amp; fcntl() kind off functions =&gt;&gt; Tss easy <a href="man7.org/linux/man-pages/man2/epoll_ctl.2.html">epoll control</a> .. </p>
</blockquote>
<h3>1. IRC commands from client to server:</h3>
<table class="doxtable">
<tr>
<th>CMD </th><th align="center">USAGE </th><th align="right">Description  </th></tr>
<tr>
<td>USER </td><td align="center"><code>USER &lt;SP&gt; &lt;username&gt; &lt;CRLF&gt;</code> </td><td align="right">Specify user for authentication </td></tr>
</table>
<h3>2. Command-Reply Sequences (Mandatory part)</h3>
<p>&gt;The server reply is defined to contain the 3-digit code, followed by space </p><blockquote class="doxtable">
<p>**&lt; SP &gt;** , followed by one line of text, and terminated by the Irc end-of-line code **&lt; CRLF &gt;** (aka <code>\r\n</code>). </p>
</blockquote>
<h3>3. Example :</h3>
<div class="fragment"><div class="line">-&gt; NICK &lt;SP&gt; Nickname &lt;CRLF&gt;</div><div class="line">-&gt; USER &lt;SP&gt; Username &lt;CRLF&gt;</div><div class="line">&lt;- 331 &lt;SP&gt; User name okay, need password. &lt;CRLF&gt;</div><div class="line">-&gt; PASS &lt;SP&gt; Password &lt;CRLF&gt;</div><div class="line">&lt;- 230 &lt;SP&gt; User logged in, proceed. &lt;CRLF&gt;</div></div><!-- fragment --> <blockquote class="doxtable">
<p><b>-&gt;</b> : Request command from client to server </p>
</blockquote>
<blockquote class="doxtable">
<p>**&lt;-** : Reply from server to client </p>
</blockquote>
<pre class="fragment">        Connection Establishment


        Registration
           USER -&gt;
              &lt;- 230
              &lt;- xxx
              &lt;- 331
           PASS -&gt;
              &lt;- 230
              &lt;- 332
              &lt;- xxx
           CWD -&gt;
              &lt;- 250
              &lt;- xxx
           CDUP -&gt;
              &lt;- 200
              &lt;- xxx

        Logout
           QUIT -&gt;
              &lt;- 221
              &lt;- xxx
</pre><h3>5. Numeric Order List of Mandatory Reply Codes (Extract)</h3>
<table class="doxtable">
<tr>
<th align="center">Code </th><th align="center">Description  </th></tr>
<tr>
<td align="center">001 </td><td align="center">The very first response from server </td></tr>
</table>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
